

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

<html>
<head>
<script type="text/javascript" src="helpman_topicinit.js"></script>

<title>Check In and Check Out Packages [Enterprise Architect User Guide]</title>

<meta name="keywords" content="Enterprise Architect, Sparx Systems, UML, Version Control,Version Control Check In and Check Out Packages,Check In,Check In Packages Online,Check In Project Browser Icon,Check In Branch,Check Out,Check Out Packages Offline,Check Out Project Browser Icon,Package,Package Check In,Package Check Out,Project Branch,Project Branch Check In,Model Branch,Model Branch Check In">
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
<meta http-equiv="Content-Style-Type" content="text/css" />

<link type="text/css" href="default.css" rel="stylesheet" />
<style type="text/css">
  A, A:Visited
  {
    color: #00F;
  }

  A:Active, A:Hover
  {
    color: #F00;
  }

  OL
  {
    margin: 5px 0 5px 48px;
  }

  UL
  {
    margin-bottom: 3px;
    margin-top: 0;
  }

  #nsr
  {
    background-color: #D4DFFF;
  }

  #nsr A
  {
    text-decoration: none;
  }

  #mainbody
  {
    padding: 8px;
  }

  .p_BodyText
  {
    padding: 5px 0;
  }
</style>



<style type="text/css" media="screen">
  BODY
  {
    background-color: #FFFFFF;
  }

  #nsr
  {
    padding: 6px 6px 0 6px;
    border-bottom: none;
    vertical-align: top;
    z-index: 2;
    visibility: visible;
    left: 0;
    top: 0;
    position: absolute;
  }

  #mainbody
  {
    left: 0;
    top: 0;
    margin: 0;
    position: absolute;
    padding: 10px;
    overflow: auto;
    height: 100%;
    z-index: 1;
    background-repeat: no-repeat;
    background-position: bottom right;
    background-attachment: fixed;
  }
</style>

<style type="text/css" media="print">
  #nsr
  {
    visibility: none;
  }

  #mainbody
  {
    overflow: visible;
  }
</style>
<script type="text/javascript" language="JavaScript" src="nonscroll.js"></script>

</head>
<body scroll="no">

<div id="page">



        <div id="content">
          <div id="content-inner">
          



  
          <div id="nsr">
            <table border="0" cellspacing="0" cellpadding="4" width="100%">
              <tr valign="top">
                <td align="left">
  


                  <p class="p_Heading1"><span class="f_Heading1">Check In and Check Out Packages</span></p>



  
                </td>
                <td align="right">
                  <a href="introduction.htm" onmouseover="document.images.main.src='button_main_h.gif'" onmouseout="document.images.main.src='button_main.gif'">
                    <img name="main" src="button_main.gif" border=0 alt="Return to Introduction">
                  </a>&nbsp;
    
                  <a href="validate_package_configuration.htm" onmouseover="document.images.prev.src='button_prev_h.gif'" onmouseout="document.images.prev.src='button_prev.gif'">
                    <img name=prev src="button_prev.gif" border=0 alt="Previous page" />
                  </a>&nbsp;
    
    
    
                  <a href="includingotheruserspackages.htm" onmouseover="document.images.next.src='button_next_h.gif'" onmouseout="document.images.next.src='button_next.gif'">
                    <img name=next src="button_next.gif" border=0 alt="Next page" />
                  </a>
    
    
                </td>
              </tr>
            </table>
          </div>
          <div id="mainbody">
  


                <p class="p_BodyText"><span class="f_BodyText">To work on a version controlled package you must have the package checked out. When a package is checked out to a specific user, a write lock is set on the package and other users cannot make changes to it until it has been checked in again.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">In the </span><span class="f_TiporNoteText">Corporate, Business and Software Engineering, System Engineering and Ultimate editions</span><span class="f_TiporNoteText"> of Enterprise Architect, if security is enabled you must have </span><span class="f_MenuKeyField"><a href="permissionlist.htm">Use Version Control</a></span><span class="f_TiporNoteText"> permission to check files in and out using version control.</span><span class="f_Bulletlist1"> </span></p>
</td>
</tr>
</table>
</div>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Check In/Check Out</span></p>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=1><span class="f_NumberedList">In the </span><span class="f_UIControl">Project Browser</span><span class="f_NumberedList">, right-click on the package icon.</span></li>
<li value=2><span class="f_NumberedList">Select the </span><span class="f_MenuKeyField">Package Control | Check In</span><span class="f_NumberedList">, </span><span class="f_MenuKeyField">Check Out</span><span class="f_NumberedList"> or </span><span class="f_MenuKeyField">Undo Checkout</span><span class="f_NumberedList"> menu options, as appropriate.</span></li>
<li value=3><span class="f_NumberedList">If required, enter a comment when prompted to do so.</span></li>
</ol>
<p class="p_BodyText"><span class="f_BodyText">If you are working in a <a href="versioncontrol.htm#Usage">private</a> model and you select the </span><span class="f_MenuKeyField">Check Out</span><span class="f_BodyText"> menu option, the </span><span class="f_UIControl">Import Package</span><span class="f_BodyText"> dialog displays (in shared models, this dialog only has default values and therefore does not display).</span></p>
<p class="p_TextIndentedL2"><img src="importpackage.png" width="226" height="226" border="0" alt="ImportPackage"></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="0" border="0" style="border: none; border-spacing:0px; border-collapse: collapse;">
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="154" bgcolor="#e3e6ed" style="width:154px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Option</span></p>
</td>
<td valign="top" width="518" bgcolor="#e3e6ed" style="width:518px; background-color:#e3e6ed; border: solid 1px #000000;"><p class="p_Tableheader"><span class="f_Tableheader">Use to</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="154" style="width:154px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Force reload from XMI</span></p>
</td>
<td valign="top" width="518" style="width:518px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Reload the package content from the XMI file in the central repository, even though the package and XMI file are synchronized. This ensures that links and dependencies that might not have been refreshed are updated as well.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="154" style="width:154px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Accept current package</span></p>
</td>
<td valign="top" width="518" style="width:518px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">(The default.) Leave the package content in its current state.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="154" style="width:154px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Refresh model view</span></p>
</td>
<td valign="top" width="518" style="width:518px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Refresh the model view to show any changes from other checked out packages.</span></p>
</td>
</tr>
<tr style="text-align:left;vertical-align:top;">
<td valign="top" width="154" style="width:154px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext" style="font-weight: bold;">Always apply above settings</span></p>
</td>
<td valign="top" width="518" style="width:518px; border: solid 1px #000000;"><p class="p_Tabletext"><span class="f_Tabletext">Apply the settings in the above three fields every time you check out a package that is found to be up to date, and therefore do not display this dialog again.</span></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 4px 2px 4px 2px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" bgcolor="#efeff7" style="background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Note:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td bgcolor="#f7f7ff" style="background-color:#f7f7ff;"><p class="p_TiporNoteText"><span class="f_TiporNoteText">To display the dialog if, for example, you want to change the settings, press </span><span class="f_MenuKeyField">[Ctrl]</span><span class="f_TiporNoteText"> while you select the </span><span class="f_MenuKeyField">Package Control | Check Out</span><span class="f_TiporNoteText"> menu option.</span></p>
</td>
</tr>
</table>
</div>
</td>
</tr>
</table>
</div>
<p class="p_BodyText"><span class="f_BodyText">The package icon in the </span><span class="f_UIControl">Project Browser</span><span class="f_BodyText"> should change. When you check out a package this is represented by a figure 8 to the left of the package icon. When you check in a package the package icon is overlaid with a colored rectangle and key. In the example below, the upper package is checked out whilst the lower package is checked in.</span></p>
<p class="p_TextIndentedL2"><img src="checkinout.png" width="108" height="34" border="0" alt="CheckInOut"></p>
<div style="text-align: left; text-indent: 0px; padding: 0px 0px 0px 0px; margin: 5px 0px 5px 13px;"><table cellspacing="0" cellpadding="2" border="0" style="border: none; border-spacing:0px;">
<tr style="text-align:left;vertical-align:bottom;">
<td valign="bottom" width="955" bgcolor="#efeff7" style="width:955px; background-color:#efeff7;"><p class="p_TiporNote" style="border-top: none; border-right: none; border-left: none;"><span class="f_TiporNote">Notes:</span></p>
</td>
</tr>
<tr style="text-align:left;">
<td width="955" bgcolor="#f7f7ff" style="width:955px; background-color:#f7f7ff;"><ul style="text-indent: 0px; margin-left: 14px; list-style-position: outside;">
<li><span class="f_TiporNoteText">If you check out a version controlled package whilst offline, the package icon has a red figure </span><span class="f_TiporNoteText" style="color: #ff0000;">8</span><span class="f_TiporNoteText"> in front of it. See <a href="offline_version_control.htm">Offline Version Control</a>.</span></li>
<li><span class="f_TiporNoteText">If the packages under version control contain any <a href="bitmapimagesindiagrams.htm">alternative images</a> </span><span class="f_TiporNoteText" style="font-weight: bold;">and</span><span class="f_TiporNoteText"> those images are subject to </span><span class="f_TiporNoteText" style="font-weight: bold;">frequent change</span><span class="f_TiporNoteText">, you can set the </span><span class="f_MenuKeyField">Export alternate images</span><span class="f_TiporNoteText"> option on the <a href="xmlspecifications.htm">Options dialog</a> to export the images to the version control repository when you check in the packages. If the images are not subject to frequent change, do not select this option and instead use <a href="importexportrefdata.htm">Export/Import Reference Data</a> to manage alternative images.</span></li>
</ul>
</td>
</tr>
</table>
</div>
<p class="p_SubHeadingL1"><span class="f_SubHeadingL1">Check In Branch<a name="branch"></a></span></p>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=1><span class="f_NumberedList">In the </span><span class="f_UIControl">Project Browser</span><span class="f_NumberedList">, right-click on the package icon at the root of the model branch that is to be checked in and select the </span><span class="f_MenuKeyField">Package Control | Check In Branch</span><span class="f_NumberedList"> context menu option. The </span><span class="f_UIControl">Select Packages to Check-in</span><span class="f_NumberedList"> dialog displays, listing all version controlled packages within the branch that you have checked out.</span><br>
<span class="f_NumberedList">&nbsp;</span><br>
<img src="checkinbranchdlg.png" width="347" height="388" border="0" alt="CheckInBranchDlg"><span class="f_NumberedList"> </span><br>
<span class="f_NumberedList">&nbsp;</span></li>
<li value=2><span class="f_NumberedList">Click on the package to check in, or use:</span></li>
</ol>
<ul style="text-indent: 0px; margin-left: 65px; list-style-position: outside;">
<li><span class="f_MenuKeyField">[Ctrl]+click</span><span class="f_Bulletlist3"> to add or remove several individual packages</span></li>
<li><span class="f_MenuKeyField">[Shift]+click</span><span class="f_Bulletlist3"> to select a range of packages</span></li>
<li><span class="f_MenuKeyField">All</span><span class="f_Bulletlist3"> to select all packages listed</span></li>
<li><span class="f_MenuKeyField">None</span><span class="f_Bulletlist3"> to clear all selected packages.</span></li>
</ul>
<ol style="text-indent: 0px; margin-left: 48px; list-style-position: outside;">
<li value=3><span class="f_NumberedList">Click on the </span><span class="f_MenuKeyField">OK</span><span class="f_NumberedList"> button to check-in the selected packages.</span></li>
<li value=4><span class="f_NumberedList">If required, enter a comment when prompted to do so. (This comment applies to all packages that you have checked in.)</span></li>
<li value=5><span class="f_NumberedList">Each package icon changes to indicate that the packages have been checked-in.</span></li>
</ol>




            </div>
          </div>
        </div>



</div>


</body>
</html>
